home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 045a / butnlm.zip / README < prev   
Text File  |  1991-05-03  |  4KB  |  110 lines
  1. ** May 3, 1991 **
  2.  
  3.  
  4. BUTIL.NLM is a utility which contains a set of commands that allow Btrieve 
  5. users to create, maintain and recover Btrieve files at the server.  BUTIL.NLM
  6. supports 10 of the commands that are implemented in BUTIL.EXE.  The
  7. following is a list of commands that are available and a short description
  8. of each: 
  9.  
  10.   * Clone
  11.     command format: Load Butil -Clone <New File> <Existing File> [-o<Owner>]
  12.  
  13.     The Clone command creates a new, empty Btrieve file with the same file
  14.     structure as an existing file.
  15.  
  16.   * Copy
  17.     command format: Load Butil -Copy  <Input File> <Output File> [-o<OwnerIn>
  18.                     [ -O <OwnerOut>]]
  19.  
  20.     The Copy command copies the contents of one Btrieve file to another.  It
  21.     is usually used to change the defined key characteristics for a Btrieve
  22.     file.
  23.    
  24.   * Create
  25.     command format: Load Butil -Create <New File> <Description File>
  26.  
  27.     The Create command builds an empty Btrieve file using the structure
  28.     specified in a description file.
  29.  
  30.   * Drop
  31.     command format: Load Butil -Drop <Btrieve File> <Key Number> [-o<Owner>]
  32.  
  33.     The Drop command is used to remove a supplemental index from a Btrieve
  34.     file.
  35.  
  36.   * Index
  37.     command format: Load Butil -Index <Btrieve File> <Index File>
  38.                     <Description File> [-o<Owner>]
  39.  
  40.     The Index command builds an external index file based on a field that
  41.     had not been specified as a key before.
  42.  
  43.   * Load
  44.     command format: Load Butil -Load <Input File> <Btrieve File> [-o<Owner>]
  45.  
  46.     The Load command allows you to insert records from a sequential file
  47.     into a Btrieve file.
  48.  
  49.   * Recover
  50.     command format: Load Butil -Recover <Btrieve File> <Output File> [-o<Owner>]
  51.  
  52.     The Recover command reads records from a Btrieve file and writes them to a 
  53.     sequential file that is compatible with the Load command.
  54.  
  55.   * Save
  56.     command format: Load Butil -Save <Btrieve File> <Output File> [<Y|N> 
  57.                     <Index File> | <Key Number>] [-o<Owner>]
  58.     
  59.     The Save command allows you to retrieve records from a Btrieve file by a
  60.     specified index path, and creates a sequential file that is compatible
  61.     with the Load command.
  62.  
  63.   * Sindex
  64.     command format: Load Butil -Sindex <Btrieve File> <Description File> 
  65.                     [-o<Owner>]
  66.  
  67.     The Sindex command creates a supplemental index for an existing Btrieve 
  68.     file.
  69.  
  70.   * Stat
  71.     command format: Load Butil -Stat <Btrieve File> [-o<Owner>]
  72.  
  73.     The Stat command returns characteristics and statistics about a Btrieve
  74.     file.
  75.  
  76. The command line:
  77.     Load Butil -Command Parameters
  78. loads the NLM, executes the operation specified and unloads the NLM.  You
  79. can either execute these commands from the console prompt, or enter them 
  80. into a NetWare Command File(NCF).
  81.  
  82. It is important to specify the complete path, including the volume name
  83. on the command line or in the NCF file.  BUTIL.NLM will return non-zero
  84. status (unsuccessful operation), when a complete path is not specified.  
  85. For example, the following command will create a file called MyFile.Btr 
  86. in the Sys: volume under the Test subdirectory using description file 
  87. MyFile.des:
  88.  
  89.   Load Butil -create Sys:\Test\MyFile.btr Sys:\Test\MyFile.des
  90.  
  91. If a NCF file is used to execute BUTIL operations, the file can only contain
  92. one BUTIL command.  In other words, to recover a damaged Btrieve file using 
  93. Recover and Load commands, you need to have two NCF files; one for the 
  94. Recover command and one for the Load command.  This is because the first 
  95. operation loads the NLM and executes the command.  Meanwhile, the second
  96. BUTIL operation tries to load the NLM while the first one is still running.
  97. In this case, the second attempt to load the BUTIL NLM will result with the
  98. error "This module is already loaded and cannot be loaded more than once".
  99.  
  100. There is no advantage for running BUTIL.NLM compared to BUTIL.EXE in many
  101. cases, such as Create, Stat and Drop.  It might even be more convenient to 
  102. run BUTIL at the workstation for most of the operations.  However, it is 
  103. much faster to recover files using the NLM version.
  104.  
  105. The BUTIL.NLM runs under the following combinations:
  106.  
  107.     1.   Netware version 3.10 with Btrieve version 5.10.
  108.     2.   Netware version 3.10 with Btrieve version 5.15.
  109.     3.   Netware version 3.11 with Btrieve version 5.15.
  110.